/*
 * Copyright 2010 Yannick Stucki (yannickstucki.com)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.yannickstucki.android.musicqueue.data;

import java.util.ArrayList;
import java.util.TreeSet;

import com.yannickstucki.android.musicqueue.communication.OnSongsUpdatedListener;

/**
 * A pure data class containing references to all the songs, all the starred
 * songs and a handler to propagate the news of a data update.
 * 
 * @author Yannick Stucki (yannickstucki@gmail.com)
 * 
 */
public class SongUpdateResult {

  /**
   * The constructor sets the references.
   */
  public SongUpdateResult(ArrayList<Song> allSongs, TreeSet<Song> starredSongs,
      OnSongsUpdatedListener handler) {
    this.allSongs = allSongs;
    this.starredSongs = starredSongs;
    this.handler = handler;
  }

  /**
   * All the songs.
   */
  private ArrayList<Song> allSongs;

  /**
   * All the starred songs.
   */
  private TreeSet<Song> starredSongs;

  /**
   * A handler to post the update of the songs to.
   */
  private OnSongsUpdatedListener handler;

  /**
   * Returns all songs.
   */
  public ArrayList<Song> getAllSongs() {
    return allSongs;
  }

  /**
   * Returns all starred songs.
   */
  public TreeSet<Song> getStarredSongs() {
    return starredSongs;
  }

  /**
   * Returns a handler to post the updates to.
   */
  public OnSongsUpdatedListener getHandler() {
    return handler;
  }
}
